home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-09 / namelist.zip / NAMELIST.DOC < prev    next >
Text File  |  1992-05-08  |  21KB  |  684 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                     NAMELIST
  16.                                     --------
  17.  
  18.                                   Version 2.01
  19.  
  20.                                Copyright (c) 1992
  21.                                   By Bill Wood
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.                            Name and Address Database
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.                                   Written by:
  47.  
  48.                                    Bill Wood,
  49.                                  P.O. Box 278,
  50.                              Lion's Head, Ontario,
  51.                                 Canada.  N0H 1W0
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.                                                     NAMELIST Ver. 2.01
  66.                                                     Copyright (c) 1992
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.                         Copyright 1992 (c) by Bill Wood
  80.                         -------------------------------
  81.  
  82.              NAMELIST ver 2.01 is not in the public domain but may be
  83.          used free of charge. You may not charge any fee for this
  84.          program or its distribution, other than normal membership
  85.          fees charged by Bulletin Board Systems. The program must be
  86.          distributed in its original form without any modifications
  87.          and with all files intact.
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.                                    DISCLAIMER
  99.                                    ----------
  100.  
  101.              This program is provided "as is" without warranty of any
  102.          kind, either expressed or implied, including but not limited
  103.          to the implied warranties of merchantability and fitness for
  104.          a particular purpose. No representation is made that this
  105.          program will meet the user's particular requirements. The
  106.          user assumes the entire risk associated with the use of this
  107.          program and is solely responsible for the use and operation
  108.          of this program for any application. The author will not be
  109.          responsible for any losses incurred or damages caused by the
  110.          use or misuse of this program.
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.                                      Page 2
  126.  
  127.                                                     NAMELIST Ver. 2.01
  128.                                                     Copyright (c) 1992
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.              As the program is documented with help screens a manual
  145.          of operations should not be required.
  146.  
  147.              I would suggest that you read this documentation, then
  148.          install the program and read each help screen in full. The
  149.          program is supplied with two records in the database as
  150.          samples. You can access the records by inputing Wood for a
  151.          last name or computer for company name at the main menu.
  152.          Input some test records of your own and play with all the
  153.          program functions. After this determine how you want to
  154.          setup your database and go to it.
  155.  
  156.          The best way to find out how the program works is to use it.
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.                                      Page 3
  188.  
  189.                                                     NAMELIST Ver. 2.01
  190.                                                     Copyright (c) 1992
  191.  
  192.  
  193.          SYNOPSIS
  194.          --------
  195.              Namelist is a program that stores and retrieves names,
  196.          addresses, telephone numbers and memo. Names may be stored as
  197.          last name and/or by company name and be retrieved by either
  198.          name. Up to five telephone numbers may be stored in each
  199.          record. A comment field is provided for short notes or
  200.          additional telephone numbers.
  201.  
  202.              The address fields hold the mailing address for the
  203.          record. The province field uses the standard two letter mail
  204.          codes for provinces of Canada and the states of the U.S.A.
  205.          All input to this field is converted to upper case if
  206.          required and validated. If a invalid code is entered a list
  207.          of all valid codes will be displayed. The postal code field
  208.          will convert all input to upper case and the program will
  209.          attempt to convert Canadian postal codes to a standard
  210.          format. If the postal code is inputed as N0H1W0 or N0H-1W0 it
  211.          will be converted to N0H 1W0 .
  212.  
  213.              A memo is attached to each record and has a compact word
  214.          processor with word wrap abilities built in. Up to 64,000
  215.          characters may be entered into each memo. This works out to
  216.          approximately 30 pages of text for each record.
  217.  
  218.              In the utilities menu, the database and memo files may be
  219.          packed, and the index files may be reindexed. Read help in
  220.          utilities for information on maintaining files. From the
  221.          utility menu, system file sizes can be displayed with the
  222.          system command.
  223.  
  224.              The label print utility is reached from the utility menu.
  225.          From the label menu, mailing labels may be printed. Read help
  226.          in label setup menu and print labels menu for information on
  227.          printing labels.
  228.  
  229.              Four tags and one filter may be set in a record to allow
  230.          selective label printing and searches. The filter field of a
  231.          record may contain a name to set conditions for searches. As
  232.          an example, if some records in the database have filter names
  233.          of COMPUTER, XMASLIST and MYLIST, and the balance of the
  234.          records have blank filter fields, with the search filter set
  235.          for XMASLIST and E (for equal to) is set, only records with a
  236.          filter field of XMASLIST will be found or printed in the
  237.          print label utility. If N (for not equal to) was selected all
  238.          records except the records with XMASLIST would be found. If
  239.          the filter setting is left blank, record filters are ignored
  240.          in a search. The tags in each record may be set to T (for
  241.          true) or F (for false) in the add or edit screens. The tags
  242.          work in the same way as the filter works.  As an example, if
  243.          in the filter menu tag1 is set to T, tag3 is set to F and
  244.          tag2 & tag4 are not set (I for ignore), only the records with
  245.          tag1 set to T and tag3 set to F would be found. Filter and
  246.          tags may be used together to set up searches.
  247.  
  248.  
  249.                                      Page 4
  250.  
  251.                                                     NAMELIST Ver. 2.01
  252.                                                     Copyright (c) 1992
  253.  
  254.  
  255.              Tag4 should not be assigned a permanent use as it has
  256.          additional functions. Tag4 can be toggled from F to T from
  257.          the search screen with F8, so you can move quickly through
  258.          the records with previous record or next record and set tag4
  259.          for special searches. Tag4 in all records can be reset to F
  260.          with the utility menu command "Set tag4 to false for all
  261.          records" .
  262.  
  263.              A new record is added to the database by selecting add in
  264.          the main menu.
  265.  
  266.              To search for and retrieve a record the last name or
  267.          company name is inputed in the main menu. The search will
  268.          find the first record that matches the characters inputed for
  269.          the search. It is not necessary to use the full name for a
  270.          search. As an example, if Woo was entered for the search the
  271.          first record with the name starting with Woo would be found.
  272.          Search is not sensitive to the case of the letters used, so a
  273.          search for the name Smith would be found with a input of
  274.          SMITH or smith.  If a record is searched for with out a name
  275.          the first record with a last name or company name will be
  276.          found.
  277.  
  278.              If a matching record is found it will be displayed on the
  279.          search screen. At the search screen you may print a copy of
  280.          the record, move to the previous or next record, toggle Tag4
  281.          from false to true or move to the edit screen to edit the
  282.          displayed record. If memo is highlighted a memo is attached
  283.          to the record and it may be viewed with the M command.
  284.  
  285.              When in the edit screen you may edit the record and the
  286.          memo.  If a memo was not attached to the record when it was
  287.          added, one may be added in the edit screen later.
  288.  
  289.              Attempts have been made to preserve the integrity of the
  290.          database files. All buffers are flushed after each record is
  291.          updated or added. I can guarantee that the buffers were
  292.          written to the disk if DOS 3.3 or higher is in use. With DOS
  293.          3.2 and lower I can not guarantee a disk write until the
  294.          files are close on program exit. A danger of file integrity
  295.          loss occurs when the program is not exited properly. This
  296.          will occur with a power loss while running the program or
  297.          exiting the program with Ctrl-Alt-Del . Read help in the
  298.          utility menu for information on files.
  299.  
  300.                  YOUR BEST INSURANCE IS REGULAR FILE BACKUPS !
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.                                      Page 5
  312.  
  313.                                                     NAMELIST Ver. 2.01
  314.                                                     Copyright (c) 1992
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.          HELP SCREENS
  328.          ------------
  329.  
  330.  
  331.          Main Menu        6 pages of help
  332.  
  333.  
  334.          Utilities Menu   3 pages of help
  335.  
  336.  
  337.          Labels           2 pages of help (at label setup)
  338.                           1 page of help  (at print labels)
  339.  
  340.  
  341.          Filter           2 pages of help
  342.  
  343.  
  344.          Search           1 page of help  (at command line)
  345.                           1 page of help  (in memo view)
  346.  
  347.  
  348.          Add Menu         4 pages of help (in input screen)
  349.                           2 pages of help (in memo add)
  350.                           4 pages of help (for invalid postal code)
  351.                           1 page of help  (at exit add line)
  352.  
  353.  
  354.          Edit Menu        4 pages of help (in input screen)
  355.                           2 pages of help (in memo edit)
  356.                           4 pages of help (in invalid postal code)
  357.                           1 page of help  (at exit edit line)
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.                                      Page 6
  374.  
  375.                                                     NAMELIST Ver. 2.01
  376.                                                     Copyright (c) 1992
  377.  
  378.  
  379.          TECHNICAL
  380.          ---------
  381.  
  382.          Memory Required       470K Minimum.
  383.                                If expanded memory is available it will
  384.                                be used for index functions to speed up
  385.                                searches.
  386.  
  387.          DOS                   Tested on DOS 3.2, 3.3, 4.01 & 5.0
  388.                                DOS 3.3 or higher is recommended.
  389.  
  390.          Records               Limited only by disk space.
  391.                                  ( 1 billion maximum )
  392.  
  393.          Index type            B-Tree
  394.  
  395.          Required files
  396.  
  397.            NAMELIST.DOC        Documentation (file you are reading)
  398.            NAMELIST.EXE        Namelist program
  399.             NL_NAME.DBF        Main database
  400.             NL_NAME.DBT        Memo database
  401.             NL_FILT.NTX        Filter index
  402.             NL_LAST.NTX        Last name index
  403.             NL_VEND.NTX        Company name index
  404.                                Note: If the .NTX files are not found
  405.                                      the program will build them
  406.                                      automatically.
  407.  
  408.          Parameters            Alarm tones and screen type can be
  409.                                controlled with the following command
  410.                                line parameters.
  411.  
  412.                    C:>NAMELIST /NOCOL          no colour
  413.                    C:>NAMELIST /NOTONE         no alarm tones
  414.                    C:>NAMELIST /NOTONE /NOCOL  no alarm tone or colour
  415.                         space ^       ^ space
  416.  
  417.                       /NOCOL should be used on systems with graphic
  418.                              adaptors and monochrome monitors. Many
  419.                              Lap Top computers are set up this way.
  420.                              If a graphic adaptor is not detected the
  421.                              program will automatically run in
  422.                              monochrome mode.
  423.  
  424.          Path                  The DOS path may be set to point to
  425.                                data files.
  426.                                eg:  PATH = <data file path name>
  427.  
  428.          Set                   The DOS environmental variable NAMELIST
  429.                                may be set to point to the data files.
  430.                                eg:  SET NAMELIST=<data file path name>
  431.                                                 ^ no space
  432.  
  433.  
  434.  
  435.                                      Page 7
  436.  
  437.                                                     NAMELIST Ver. 2.01
  438.                                                     Copyright (c) 1992
  439.  
  440.  
  441.          INSTALLATION
  442.          ------------
  443.  
  444.          Floppy disk:
  445.  
  446.              I do not recommend that this program be run from a floppy
  447.          disk as the size of the database would be very limiting
  448.          (especially on a 360K disk), and the record search time will
  449.          be slow. If you wish to run the program from a floppy disk,
  450.          copy all the files to the floppy disk and make the drive with
  451.          the program files your current drive. Typing the command
  452.          NAMELIST will run the program.
  453.  
  454.  
  455.          Hard disk:
  456.  
  457.              All the data and index files must be in one directory.
  458.          For this example, the files will be placed in directory
  459.          \NAMELIST on drive C: . Make a directory on drive C: named
  460.          NAMELIST and copy all the files to C:\NAMELIST .
  461.  
  462.              If you make C:\NAMELIST the current drive and directory,
  463.          NAMELIST may be run with the command NAMELIST with on further
  464.          action.
  465.  
  466.              The program may be run from other drives and directories
  467.          if a path is set to C:\NAMELIST. (eg: C:>PATH = C:NAMELIST)
  468.  
  469.              The program on start up checks for an environmental
  470.          variable named NAMELIST pointing to the drive and directory
  471.          for the program. If the variable is found and it points to a
  472.          directory with valid database files the program will run. If
  473.          the files are not found the program will abort.
  474.  
  475.            NAMELIST uses one of three ways to locate it's files:
  476.  
  477.          -  First the program checks for it's environmental variable.
  478.             If the variable is found, the files in the directory
  479.             pointed to by the variable are run. If for some reason the
  480.             files are not found the program aborts.
  481.  
  482.          -  If no environmental variable is found the program checks
  483.             the current directory for the data files. If the files are
  484.             found the program runs.
  485.  
  486.          -  If the files are not found in the current directory all
  487.             DOS paths are checked for the files. The first directory
  488.             containing valid files is used and the program runs. If
  489.             the data files are not found in any directory or no path
  490.             was set the program aborts.
  491.  
  492.                 Under most conditions loading all the files to one
  493.             directory and setting the DOS path will be sufficient for
  494.             running the program.
  495.  
  496.  
  497.                                      Page 8
  498.  
  499.                                                     NAMELIST Ver. 2.01
  500.                                                     Copyright (c) 1992
  501.  
  502.  
  503.          ENVIRONMENTAL VARIABLE
  504.          ----------------------
  505.  
  506.              The environmental variable may be used for special setups
  507.          such as having the program run three different databases.
  508.  
  509.              As an example, we will setup a system for Jim, Sam and
  510.          Bill all with their individual data files.
  511.  
  512.              First make a directory named NAMELIST and then make
  513.          subdirectories JIM , SAM , and BILL under NAMELIST .
  514.  
  515.                  C:-|
  516.                     |-\NAMELIST-|
  517.                                 |-\JIM
  518.                                 |-\SAM
  519.                                 |-\BILL
  520.  
  521.              Now copy NL_NAME.DBF & NL_NAME.DBT to C:\NAMELIST\JIM ,
  522.          C:\NAMELIST\SAM and C:\NAMELIST\BILL . Now copy NAMELIST.EXE
  523.          to C:\NAMELIST . The .NTX files are not required as the
  524.          program will build them the first time the data files are
  525.          used.
  526.  
  527.              The following three batch files will run NAMELIST for
  528.          Jim, Sam and Bill with their own data files.
  529.  
  530.  
  531.          REM Jim's file                  REM Sam's file
  532.          REM name this file JIM.BAT      REM name this file SAM.BAT
  533.          ECHO OFF                        ECHO OFF
  534.          SET NAMELIST=C:\NAMELIST\JIM    SET NAMELIST=C:\NAMELIST\SAM
  535.          C:\NAMELIST\NAMELIST            C:\NAMELIST\NAMELIST
  536.          SET NAMELIST=                   SET NAMELIST=
  537.          REM eof                         REM eof
  538.  
  539.  
  540.          REM Bill's file
  541.          REM name this file BILL.BAT
  542.          ECHO OFF
  543.          SET NAMELIST=C:\NAMELIST\BILL
  544.          REM Bill doesn't like the alarm tone
  545.          C:\NAMELIST\NAMELIST /NOTONE
  546.          SET NAMELIST=
  547.          REM eof
  548.  
  549.  
  550.              When the above batch files are run they will select the
  551.          appropriate data files for Jim, Sam or Bill. The batch files
  552.          may be in any directory if the DOS path is set to point to
  553.          them.
  554.  
  555.  
  556.  
  557.  
  558.  
  559.                                      Page 9
  560.  
  561.                                                     NAMELIST Ver. 2.01
  562.                                                     Copyright (c) 1992
  563.  
  564.  
  565.          416TO905.EXE
  566.          ------------
  567.  
  568.  
  569.  
  570.  
  571.              On October 4th, 1993 telephone area code 416 will be
  572.          divided into two and a new 905 area will be introduced.
  573.  
  574.              I have included a utility to help you with this change of
  575.          area codes. The utility named 416TO905 when run, will replace
  576.          phone numbers with area codes 416 with area code 905 if the
  577.          phone number falls in the new area.
  578.  
  579.              The utility uses the postal code as the key to determine
  580.          if the area code should be changed. All postal codes starting
  581.          with the letter M will remain in area 416 and all others will
  582.          change to 905. Only records with valid postal codes will be
  583.          changed.
  584.  
  585.              DO NOT use this utility until October of 1993 and make a
  586.          BACKUP of NL_NAME.DBF and NL_NAME.DBT before using this
  587.          utility.
  588.  
  589.              NL_NAME.DBF must be in the current directory to run this
  590.          program.
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.                                     Page 10
  622.  
  623.                                                     NAMELIST Ver. 2.01
  624.                                                     Copyright (c) 1992
  625.  
  626.  
  627.          THE AUTHOR
  628.          ----------
  629.  
  630.              I have not placed this program in the public domain as I
  631.          may expand the program and offer it as a commercial package
  632.          in the future. You may use this version of the program as you
  633.          wish free of charge. If you do make use of the program, I
  634.          would appreciate your comments on the program and suggestion
  635.          for additional features.
  636.  
  637.              Some of the additional features I have on my list are:
  638.  
  639.                  - Importing text files into record memos.
  640.  
  641.                  - Exporting the database as a delimited file.
  642.  
  643.                  - Ability to search on any combination of fields and
  644.                    conditions then save the search queries for later
  645.                    use.
  646.  
  647.                  - Network version.
  648.  
  649.                  - Auto phone dialer via a modem using stored numbers.
  650.  
  651.  
  652.  
  653.              My computer experience goes back to the mid 70's
  654.          and since that time I have been involved with mainframe
  655.          computers, date communications and micro computers. I am now
  656.          freelance programing, offering a programing service for
  657.          specialized micro computer programs and utilities. If you
  658.          have any micro computer programing needs or require
  659.          assistance with computer related problems, please feel free
  660.          to contact me.
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.                                         Happy computing !
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.  
  678.  
  679.  
  680.  
  681.  
  682.  
  683.                                     Page 11
  684.